Skip to content

Remove variable syntax for icons#864

Merged
Chng-Zhi-Xuan merged 4 commits into
MarkBind:masterfrom
Chng-Zhi-Xuan:712-remove-variable-syntax-for-icons
May 27, 2019
Merged

Remove variable syntax for icons#864
Chng-Zhi-Xuan merged 4 commits into
MarkBind:masterfrom
Chng-Zhi-Xuan:712-remove-variable-syntax-for-icons

Conversation

@Chng-Zhi-Xuan

@Chng-Zhi-Xuan Chng-Zhi-Xuan commented May 21, 2019

Copy link
Copy Markdown
Contributor

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [x] Other, please explain: depreciation of old feature.

**Note: This is a breaking change, will have to increment a minor version for next release

Resolves #712

What is the rationale for this request?

Since #680 syntax change, the team has postponed depreciating the old syntax until the academic semester is over. Now that it is summer, the team has the green light to proceed with the depreciation.

What changes did you make? (Give an overview)

  • Remove glyphicon.csv and font-awesome.csv from src/assets
  • Remove getIconsMap method from Site.js, along with any related constants used.
  • Update Site.test.js unit tests
  • Fix minor documentation nit within icons.mbdf

Is there anything you'd like reviewers to focus on?

  • Commit messages

Testing instructions:

  1. Open Netlify Preview and check that icons within the documentation is not broken.
  2. Checkout the PR branch, Init, author a new MarkBind website with the old syntax for icons e.g. {{ glyphicon-home }}
  3. The icons should be rendered as NaN as it doesn't exist.
  4. Replace the double braces {{ }} with colons : : and the icons should render properly.

The files were used as a template to build the iconsMap
for using variable syntax to insert icons.

Since MarkBind#680, we have shifted to another syntax for inserting
icons. We made the decision to depreciate the old
variable syntax. Thus it renders the current icon .csv files
as obsolete.

Let's remove these files as well when depreciating the
variable syntax for icons.
The example text refernces :far-file-code:, however
the icon rendered was :fas-file-code:.

Let's correct this minor documentation mistake.
@Chng-Zhi-Xuan Chng-Zhi-Xuan added the breakingChange 💥 Feature will behave significantly different, or is made obsolete label May 21, 2019
@Chng-Zhi-Xuan Chng-Zhi-Xuan merged commit 9c9332a into MarkBind:master May 27, 2019
@Chng-Zhi-Xuan Chng-Zhi-Xuan added this to the v2.5.0 milestone May 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breakingChange 💥 Feature will behave significantly different, or is made obsolete

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove variable syntax for icons

1 participant